<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityBrokerRESTServiceManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityBrokerRESTServiceManager.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-rest/xref/org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html $</em>
<a name="4" href="#4">4</a>   <em> * TestManager.java - entity-broker - Jul 23, 2008 6:27:29 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.<strong>rest</strong>;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBrokerManager;
<a name="24" href="#24">24</a>  <strong>import</strong> org.sakaiproject.entitybus.access.EntityViewAccessProviderManager;
<a name="25" href="#25">25</a>  <strong>import</strong> org.sakaiproject.entitybus.access.HttpServletAccessProviderManager;
<a name="26" href="#26">26</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderManager;
<a name="27" href="#27">27</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderMethodStore;
<a name="28" href="#28">28</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestGetterWrite;
<a name="29" href="#29">29</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.RequestStorageWrite;
<a name="30" href="#30">30</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityPropertiesService;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <em>/**<em>*</em></em>
<a name="34" href="#34">34</a>  <em> * This creates all the needed services (as if it were a service manager),</em>
<a name="35" href="#35">35</a>  <em> * this will let us create the services we need without too much confusion and ensure</em>
<a name="36" href="#36">36</a>  <em> * we are using the same ones &lt;br/></em>
<a name="37" href="#37">37</a>  <em> * If this is used then the services should not be created in some other way but should be</em>
<a name="38" href="#38">38</a>  <em> * initiated here and then exported from this class only</em>
<a name="39" href="#39">39</a>  <em> * </em>
<a name="40" href="#40">40</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="41" href="#41">41</a>  <em> */</em>
<a name="42" href="#42">42</a>  @SuppressWarnings(<span class="string">"deprecation"</span>)
<a name="43" href="#43">43</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a> {
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>      <strong>private</strong> <strong>static</strong> <strong>volatile</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a> instance;
<a name="46" href="#46">46</a>      <strong>public</strong> <strong>static</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a> getInstance() {
<a name="47" href="#47">47</a>          <strong>if</strong> (instance == <strong>null</strong>) {
<a name="48" href="#48">48</a>              instance = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a>();
<a name="49" href="#49">49</a>          }
<a name="50" href="#50">50</a>          <strong>return</strong> instance;
<a name="51" href="#51">51</a>      }
<a name="52" href="#52">52</a>      <strong>public</strong> <strong>static</strong> <strong>void</strong> setInstance(<a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a> ersm) {
<a name="53" href="#53">53</a>          instance = ersm;
<a name="54" href="#54">54</a>      }
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <em class="comment">// services we need</em>
<a name="57" href="#57">57</a>      <strong>private</strong> RequestStorageWrite requestStorage;
<a name="58" href="#58">58</a>      <strong>private</strong> RequestGetterWrite requestGetter;
<a name="59" href="#59">59</a>      <strong>private</strong> EntityPropertiesService entityPropertiesService;
<a name="60" href="#60">60</a>      <strong>private</strong> EntityBrokerManager entityBrokerManager;
<a name="61" href="#61">61</a>      <strong>private</strong> EntityProviderManager entityProviderManager;
<a name="62" href="#62">62</a>      <strong>private</strong> EntityProviderMethodStore entityProviderMethodStore;
<a name="63" href="#63">63</a>      <strong>private</strong> HttpServletAccessProviderManager httpServletAccessProviderManager;
<a name="64" href="#64">64</a>      <strong>private</strong> EntityViewAccessProviderManager entityViewAccessProviderManager;
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>      <em class="comment">// services we are starting up</em>
<a name="67" href="#67">67</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityActionsManager.html">EntityActionsManager</a> entityActionsManager;
<a name="68" href="#68">68</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a> entityDescriptionManager;
<a name="69" href="#69">69</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> entityEncodingManager;
<a name="70" href="#70">70</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRedirectsManager.html">EntityRedirectsManager</a> entityRedirectsManager;
<a name="71" href="#71">71</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a> entityRequestHandler;
<a name="72" href="#72">72</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a> entityBatchHandler;
<a name="73" href="#73">73</a>      <strong>private</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRESTProviderBase.html">EntityRESTProviderBase</a> entityRESTProvider;
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <strong>public</strong> <strong>void</strong> setEntityBrokerManager(EntityBrokerManager entityBrokerManager) {
<a name="76" href="#76">76</a>          <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="77" href="#77">77</a>          <strong>this</strong>.requestStorage = entityBrokerManager.getRequestStorage();
<a name="78" href="#78">78</a>          <strong>this</strong>.requestGetter = entityBrokerManager.getRequestGetter();
<a name="79" href="#79">79</a>          <strong>this</strong>.entityPropertiesService = entityBrokerManager.getEntityPropertiesService();
<a name="80" href="#80">80</a>          <strong>this</strong>.entityProviderManager = entityBrokerManager.getEntityProviderManager();
<a name="81" href="#81">81</a>          <strong>this</strong>.entityProviderMethodStore = entityBrokerManager.getEntityProviderMethodStore();
<a name="82" href="#82">82</a>          <strong>this</strong>.entityViewAccessProviderManager = entityBrokerManager.getEntityViewAccessProviderManager();
<a name="83" href="#83">83</a>      }
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <strong>protected</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a>() { }
<a name="86" href="#86">86</a>  
<a name="87" href="#87">87</a>      <em>/**<em>*</em></em>
<a name="88" href="#88">88</a>  <em>     * Base constructor</em>
<a name="89" href="#89">89</a>  <em>     * @param entityBrokerManager the main entity broker manager service</em>
<a name="90" href="#90">90</a>  <em>     */</em>
<a name="91" href="#91">91</a>      <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a>(EntityBrokerManager entityBrokerManager) {
<a name="92" href="#92">92</a>          <strong>this</strong>(entityBrokerManager, <strong>null</strong>);
<a name="93" href="#93">93</a>      }
<a name="94" href="#94">94</a>  
<a name="95" href="#95">95</a>      <em>/**<em>*</em></em>
<a name="96" href="#96">96</a>  <em>     * Full constructor</em>
<a name="97" href="#97">97</a>  <em>     * @param entityBrokerManager the main entity broker manager service</em>
<a name="98" href="#98">98</a>  <em>     * @param httpServletAccessProviderManager (optional)</em>
<a name="99" href="#99">99</a>  <em>     */</em>
<a name="100" href="#100">100</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBrokerRESTServiceManager.html">EntityBrokerRESTServiceManager</a>(EntityBrokerManager entityBrokerManager,
<a name="101" href="#101">101</a>             HttpServletAccessProviderManager httpServletAccessProviderManager) {
<a name="102" href="#102">102</a>         <strong>super</strong>();
<a name="103" href="#103">103</a>         <strong>if</strong> (entityBrokerManager == <strong>null</strong>) {
<a name="104" href="#104">104</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"entityBrokerManager cannot be null"</span>);
<a name="105" href="#105">105</a>         }
<a name="106" href="#106">106</a>         setEntityBrokerManager(entityBrokerManager);
<a name="107" href="#107">107</a>         <strong>this</strong>.httpServletAccessProviderManager = httpServletAccessProviderManager;
<a name="108" href="#108">108</a>         init();
<a name="109" href="#109">109</a>     }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <em>/**<em>*</em></em>
<a name="112" href="#112">112</a> <em>     * WARNING: If you use the non-empty constructors to make this object then do not run this,</em>
<a name="113" href="#113">113</a> <em>     * it has already been run and should not be run a second time &lt;br/></em>
<a name="114" href="#114">114</a> <em>     * Startup all the REST services for the EB system,</em>
<a name="115" href="#115">115</a> <em>     * this can only be run after this is constructed with a full constructor or </em>
<a name="116" href="#116">116</a> <em>     * the {@link #setEntityBrokerManager(EntityBrokerManager)} method has been called</em>
<a name="117" href="#117">117</a> <em>     * (i.e. all the required services are set)</em>
<a name="118" href="#118">118</a> <em>     */</em>
<a name="119" href="#119">119</a>     <strong>public</strong> <strong>void</strong> init() {
<a name="120" href="#120">120</a>         <strong>if</strong> (<strong>this</strong>.entityBrokerManager == <strong>null</strong>
<a name="121" href="#121">121</a>                 || <strong>this</strong>.requestGetter == <strong>null</strong>
<a name="122" href="#122">122</a>                 || <strong>this</strong>.requestStorage == <strong>null</strong>
<a name="123" href="#123">123</a>                 || <strong>this</strong>.entityPropertiesService == <strong>null</strong>
<a name="124" href="#124">124</a>                 || <strong>this</strong>.entityProviderManager == <strong>null</strong>
<a name="125" href="#125">125</a>                 || <strong>this</strong>.entityProviderMethodStore == <strong>null</strong>
<a name="126" href="#126">126</a>                 || <strong>this</strong>.entityViewAccessProviderManager == <strong>null</strong>) {
<a name="127" href="#127">127</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Main services must all be set and non-null!"</span>);
<a name="128" href="#128">128</a>         }
<a name="129" href="#129">129</a>         <em class="comment">// initialize all the parts</em>
<a name="130" href="#130">130</a>         entityActionsManager = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityActionsManager.html">EntityActionsManager</a>(entityProviderMethodStore);
<a name="131" href="#131">131</a>         entityRedirectsManager = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRedirectsManager.html">EntityRedirectsManager</a>(entityProviderMethodStore, requestStorage);
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>         entityDescriptionManager = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a>(entityViewAccessProviderManager,
<a name="134" href="#134">134</a>                 httpServletAccessProviderManager, entityProviderManager, entityPropertiesService,
<a name="135" href="#135">135</a>                 entityBrokerManager, entityProviderMethodStore);
<a name="136" href="#136">136</a>         entityEncodingManager = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a>(entityProviderManager, entityBrokerManager);
<a name="137" href="#137">137</a>         entityBatchHandler = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a>(entityBrokerManager, entityEncodingManager);
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a>         entityRequestHandler = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a>(entityProviderManager,
<a name="140" href="#140">140</a>                 entityBrokerManager, entityEncodingManager, entityDescriptionManager,
<a name="141" href="#141">141</a>                 entityViewAccessProviderManager, requestGetter, entityActionsManager,
<a name="142" href="#142">142</a>                 entityRedirectsManager, entityBatchHandler, requestStorage);
<a name="143" href="#143">143</a>         entityRequestHandler.setAccessProviderManager( httpServletAccessProviderManager );
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>         entityRESTProvider = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRESTProviderBase.html">EntityRESTProviderBase</a>(entityBrokerManager, 
<a name="146" href="#146">146</a>                 entityActionsManager, entityEncodingManager, entityRequestHandler);
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>         setInstance(<strong>this</strong>);
<a name="149" href="#149">149</a>     }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>     <em>/**<em>*</em></em>
<a name="152" href="#152">152</a> <em>     * Shutdown the services</em>
<a name="153" href="#153">153</a> <em>     * (just calls over to destroy)</em>
<a name="154" href="#154">154</a> <em>     */</em>
<a name="155" href="#155">155</a>     <strong>public</strong> <strong>void</strong> shutdown() {
<a name="156" href="#156">156</a>         destroy();
<a name="157" href="#157">157</a>     }
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>     <em>/**<em>*</em></em>
<a name="160" href="#160">160</a> <em>     * Shuts down all services and cleans up</em>
<a name="161" href="#161">161</a> <em>     */</em>
<a name="162" href="#162">162</a>     <strong>public</strong> <strong>void</strong> destroy() {
<a name="163" href="#163">163</a>         <em class="comment">// cleanup everything</em>
<a name="164" href="#164">164</a>         setInstance(<strong>null</strong>);
<a name="165" href="#165">165</a>         <strong>this</strong>.entityRESTProvider.destroy();
<a name="166" href="#166">166</a>         <strong>this</strong>.entityRESTProvider = <strong>null</strong>;
<a name="167" href="#167">167</a>         <strong>this</strong>.entityRequestHandler = <strong>null</strong>;
<a name="168" href="#168">168</a>         <strong>this</strong>.entityBatchHandler = <strong>null</strong>;
<a name="169" href="#169">169</a>         <strong>this</strong>.entityEncodingManager = <strong>null</strong>;
<a name="170" href="#170">170</a>         <strong>this</strong>.entityDescriptionManager.destroy();
<a name="171" href="#171">171</a>         <strong>this</strong>.entityDescriptionManager = <strong>null</strong>;
<a name="172" href="#172">172</a>         <strong>this</strong>.entityRedirectsManager = <strong>null</strong>;
<a name="173" href="#173">173</a>         <strong>this</strong>.entityActionsManager = <strong>null</strong>;
<a name="174" href="#174">174</a>     }
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityActionsManager.html">EntityActionsManager</a> getEntityActionsManager() {
<a name="177" href="#177">177</a>         <strong>return</strong> entityActionsManager;
<a name="178" href="#178">178</a>     }
<a name="179" href="#179">179</a>     
<a name="180" href="#180">180</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a> getEntityDescriptionManager() {
<a name="181" href="#181">181</a>         <strong>return</strong> entityDescriptionManager;
<a name="182" href="#182">182</a>     }
<a name="183" href="#183">183</a>     
<a name="184" href="#184">184</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityEncodingManager.html">EntityEncodingManager</a> getEntityEncodingManager() {
<a name="185" href="#185">185</a>         <strong>return</strong> entityEncodingManager;
<a name="186" href="#186">186</a>     }
<a name="187" href="#187">187</a>     
<a name="188" href="#188">188</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRedirectsManager.html">EntityRedirectsManager</a> getEntityRedirectsManager() {
<a name="189" href="#189">189</a>         <strong>return</strong> entityRedirectsManager;
<a name="190" href="#190">190</a>     }
<a name="191" href="#191">191</a>     
<a name="192" href="#192">192</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityHandlerImpl.html">EntityHandlerImpl</a> getEntityRequestHandler() {
<a name="193" href="#193">193</a>         <strong>return</strong> entityRequestHandler;
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a>     
<a name="196" href="#196">196</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityBatchHandler.html">EntityBatchHandler</a> getEntityBatchHandler() {
<a name="197" href="#197">197</a>         <strong>return</strong> entityBatchHandler;
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a>     
<a name="200" href="#200">200</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityRESTProviderBase.html">EntityRESTProviderBase</a> getEntityRESTProvider() {
<a name="201" href="#201">201</a>         <strong>return</strong> entityRESTProvider;
<a name="202" href="#202">202</a>     }
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

